/*
 * RessourceDef.hpp
 * This file is part of Dragon and Weed 2
 *
 * Copyright (C) 2011 - François Berder, Syméon Malengreau

 *
 * Dragon and Weed 2 is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * Dragon and Weed 2 is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 */



#ifndef RESSOURCEDEF_HPP_INCLUDED
#define RESSOURCEDEF_HPP_INCLUDED

#include <string>

/* This class contains useful information to provide about
 * a ressource to the ressource manager.
 */
 /** \class RessourceDef
     \brief This class regroups useful information to provide for a ressource in a ressource manager.
 */
class RessourceDef
{
	public :

	/* Default constructor. It is compulsory to give a name
	 * for a ressource.
	 * Note : size is only useful for a font.
	 */
	 /** \brief Default constructor
        \param name The path of the ressource
        \param size The size of the ressource.

        \note The size attribute is only needed for loading fonts.
	 */
	RessourceDef(const std::string &name, const unsigned int size = 0);


	 /** \brief Default operator< so that this class can be used as a key in a ressource manager.
	 */
	friend bool operator<(const RessourceDef& a, const RessourceDef& b);


	const std::string m_name;
	const unsigned int m_size;
};

#endif // RESSOURCEDEF_HPP_INCLUDED

